This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.
This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.
| The list of the themes | Global methods by category | Global methods by name | The list of the classes | The list of the controls |
class QTFileTransfer | ||||
| control, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
An easy control to download FTP and HTTP files. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
Abort | ||||
| method, QTFileTransfer | Fr, 23. Aug 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
Closes the transfer. | ||||
|
Notes:
File and download are closed, but the file may still exists on the disk. Requires QuickTime 4.0 or newer. | ||||
BytesToTransfer as integer | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
How much bytes will be transferred. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
BytesTransferred as integer | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
How much bytes were transferred. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
CurrentURL as string | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
The URL of the last transfer. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
DataBufferSize as integer | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
How big the data buffer should be. | ||||
|
Notes:
Default is 10240 Bytes. Requires QuickTime 4.0 or newer. | ||||
DataReceived(length as integer, data as string) | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is called whenever some bytes have arrived. | ||||
|
Notes:
These bytes are written to the destination file. Requires QuickTime 4.0 or newer. | ||||
DataRequest(length as integer) | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is called when the next bytes are requested from the server. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
DataSize(length as integer) | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is called when the size of the file was detected. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
DataWritten(length as integer,data as string) | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is called whenever some bytes have been written to the destination file. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
DoneTransferring as boolean | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
Transfer done? | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
FileSize(url as string) as integer | ||||
| method, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
Contacts the Server of this URL to return the size of this file. | ||||
|
Notes:
Should be 0 on error and -1 if the file size information is not available from the server (e.g. old FTP Server version). Requires QuickTime 4.0 or newer. | ||||
MacCreator as string | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
The Creator code on Mac for this file used when it's created. | ||||
|
Notes:
Default is "????". Requires QuickTime 4.0 or newer. | ||||
MacType as string | ||||
| property, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
The Type code on Mac for this file used when it's created. | ||||
|
Notes:
Default is "????". Requires QuickTime 4.0 or newer. | ||||
Open | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is fired before the control is created so you can change the properties just before. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
Open | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is fired just before the control is destroyed so you can clean up your stuff. | ||||
|
Notes:
Requires QuickTime 4.0 or newer. | ||||
Poll | ||||
| method, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
Call this method from a timer to make this control doing it's job. | ||||
|
Notes:
This is the only way to give CPU time to this control. Should be called from a timer while downloading. Requires QuickTime 4.0 or newer. | ||||
Transfer(url as string, file as folderitem) as boolean | ||||
| method, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
Starts a file download. | ||||
|
Notes:
Should return within a second and return false on any error. Requires QuickTime 4.0 or newer. | ||||
TransferComplete | ||||
| event, QTFileTransfer | Mo, 10. Jun 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | ||
|
Function:
This event is called after the last byte was written. | ||||
|
Notes:
Please don't close the window of this Control directly than. Requires QuickTime 4.0 or newer. | ||||
Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.